Validate `define()` and `const` values against explicit types in `dynamicConstantNames` by phpstan-bot · Pull Request #5648 · phpstan/phpstan-src

phpstan-bot · 2026-05-12T12:19:24Z

Summary

When dynamicConstantNames is configured with an explicit type (e.g., BAR_CONSTANT: 'int|string|null'), PHPStan now validates that the value assigned via define(), const, or class constant declarations is compatible with that configured type. Previously, incompatible values were silently accepted.

Changes

Added getExplicitGlobalConstantType() and getExplicitClassConstantType() methods to src/Analyser/ConstantResolver.php to retrieve the configured explicit type from dynamicConstantNames without applying it as a resolution
Created src/Rules/Constants/ValueAssignedToDefineRule.php (level 2) — validates define('X', value) calls against explicit types in dynamicConstantNames
Created src/Rules/Constants/ValueAssignedToGlobalConstantRule.php (level 2) — validates file-level const X = value statements against explicit types in dynamicConstantNames
Extended src/Rules/Constants/ValueAssignedToClassConstantRule.php — when no PHPDoc @var or native type is present, now also checks against explicit types in dynamicConstantNames for class constants

Analogous cases probed

define() function calls — new ValueAssignedToDefineRule
File-level const statements — new ValueAssignedToGlobalConstantRule
Class constants — extended ValueAssignedToClassConstantRule to also validate against dynamicConstantNames explicit types when no other type source exists

Root cause

The dynamicConstantNames configuration with explicit types (associative entries like BAR_CONSTANT: 'int|string|null') was only used to resolve the constant's type when reading it, but never to validate the value when defining it. There were no rules checking that the value assigned in define(), const, or class constant declarations was compatible with the configured type.

Test

tests/PHPStan/Rules/Constants/ValueAssignedToDefineRuleTest.php — tests define() with compatible and incompatible values
tests/PHPStan/Rules/Constants/ValueAssignedToGlobalConstantRuleTest.php — tests file-level const with incompatible value
tests/PHPStan/Rules/Constants/ValueAssignedToClassConstantWithDynamicNamesRuleTest.php — tests class constants with incompatible value against dynamicConstantNames explicit type

Fixes phpstan/phpstan#14600

VincentLanglet · 2026-05-12T14:49:25Z

I'll comment this without triggering a reaction from the bot to let you the choice @staabm because I'm unsure about this

In ValueAssignedToClassConstantRule, can't we just do

$phpDocType = $constantReflection->getPhpDocType();
if ($phpDocType === null && $this->checkDynamicConstantNameValues) {
    $phpDocType = $this->constantResolver->getExplicitClassConstantType($classReflection->getName(), $constantName);
}

and rely on the existing logic ?

Should we add a tip to explains where come from the type we use ?
Should we use different identifier for ValueAssignedToDefineRule and ValueAssignedToGlobalConstantRule ?

staabm · 2026-05-12T15:51:41Z

in ValueAssignedToClassConstantRule, can't we just do

if we do this, we get a error message which is misleading (hinting a phpdoc type)

PHPDoc tag @var for constant ValueAssignedToClassConstantDynamicNames\Foo::BAR with type int|string|null is incompatible with value false.

2. Should we add a tip to explains where come from the type we use ?

I tried to improve the error message

3. Should we use different identifier for ValueAssignedToDefineRule and ValueAssignedToGlobalConstantRule ?

done

…amicConstantNames` - Add `getExplicitGlobalConstantType()` and `getExplicitClassConstantType()` methods to `ConstantResolver` to retrieve the configured type from `dynamicConstantNames` without applying it - Add `ValueAssignedToDefineRule` (level 2) that validates `define()` call values against the explicit type configured in `dynamicConstantNames` - Add `ValueAssignedToGlobalConstantRule` (level 2) that validates file-level `const` statement values against the explicit type configured in `dynamicConstantNames` - Extend `ValueAssignedToClassConstantRule` to also validate class constant values against explicit types in `dynamicConstantNames` when no PHPDoc or native type is present

The new rules (ValueAssignedToDefineRule, ValueAssignedToGlobalConstantRule) and the dynamicConstantNames check in ValueAssignedToClassConstantRule are now only enabled when bleeding edge is active, via the new checkDynamicConstantNameValues feature toggle. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…plicit*Type methods Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Refactor resolveConstantType/resolveClassConstantType to reuse getExplicitGlobalConstantType/getExplicitClassConstantType instead of duplicating the type string resolution logic. Update ValueAssignedToDefineRule to iterate over all constant name strings instead of bailing out when count !== 1, so define() calls with union-typed names are checked too. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…nedToDefineRule - Refactor resolveConstantType() and resolveClassConstantType() to reuse getExplicitGlobalConstantType() and getExplicitClassConstantType() instead of duplicating the TypeStringResolver lookup logic. - Update ValueAssignedToDefineRule to iterate over all constant name strings from the define() call, not just when there is exactly one. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

VincentLanglet · 2026-05-16T08:43:38Z

+						$verbosity = VerbosityLevel::getRecommendedLevelByType($configuredType, $valueExprType);
+						return [
+							RuleErrorBuilder::message(sprintf(
+								'Configuration defined type for constant %s::%s (%s) is incompatible with value %s.',


Suggested change

'Configuration defined type for constant %s::%s (%s) is incompatible with value %s.',

'Configuration defined type for constant %s::%s (%s) does not accept value %s.',

Done. Changed the error message wording from "is incompatible with value" to "does not accept value" in all three rule files (ValueAssignedToClassConstantRule, ValueAssignedToDefineRule, ValueAssignedToGlobalConstantRule) and their corresponding tests. All tests pass and make phpstan reports no errors.

VincentLanglet · 2026-05-16T08:43:55Z

+			$verbosity = VerbosityLevel::getRecommendedLevelByType($configuredType, $valueType);
+
+			$errors[] = RuleErrorBuilder::message(sprintf(
+				'Configuration defined type for constant %s (%s) is incompatible with value %s.',


Suggested change

'Configuration defined type for constant %s (%s) is incompatible with value %s.',

'Configuration defined type for constant %s (%s) does not accept value %s.',

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

staabm reviewed May 12, 2026

View reviewed changes

Comment thread src/Rules/Constants/ValueAssignedToGlobalConstantRule.php

staabm reviewed May 12, 2026

View reviewed changes

Comment thread src/Analyser/ConstantResolver.php Outdated

staabm reviewed May 12, 2026

View reviewed changes

Comment thread src/Rules/Constants/ValueAssignedToClassConstantRule.php

staabm reviewed May 12, 2026

View reviewed changes

Comment thread src/Rules/Constants/ValueAssignedToDefineRule.php Outdated

staabm requested a review from VincentLanglet May 12, 2026 13:46

staabm approved these changes May 12, 2026

View reviewed changes

staabm and others added 7 commits May 16, 2026 08:47

DRY resolveConstantType and resolveClassConstantType by reusing getEx…

ef0d121

…plicit*Type methods Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Update ValueAssignedToDefineRule.php

c3524c1

try to improve message

5b39181

staabm force-pushed the create-pull-request/patch-z2pzrmn branch from 4268892 to 5b39181 Compare May 16, 2026 06:47

staabm reviewed May 16, 2026

View reviewed changes

Comment thread src/Analyser/ConstantResolver.php Outdated

Comment thread src/Analyser/ConstantResolver.php Outdated

Rename getExplicit*ConstantType to getConfigured*ConstantType

23610b1

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

staabm reviewed May 16, 2026

View reviewed changes

Comment thread src/Rules/Constants/ValueAssignedToClassConstantRule.php

Add test for Maybe accepts path in ValueAssignedToClassConstantRule

822b755

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

VincentLanglet reviewed May 16, 2026

View reviewed changes

Use 'does not accept value' wording in configured constant type errors

6cb0618

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

VincentLanglet approved these changes May 16, 2026

View reviewed changes

VincentLanglet assigned staabm May 16, 2026

staabm reviewed May 16, 2026

View reviewed changes

Comment thread src/Analyser/ConstantResolver.php

Cache resolved configured constant types in ConstantResolver

b6ad165

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

staabm reviewed May 16, 2026

View reviewed changes

Comment thread src/Rules/Constants/ValueAssignedToGlobalConstantRule.php

Add test for Maybe accepts path in ValueAssignedToGlobalConstantRule

12b7d5e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

staabm merged commit 9abd515 into phpstan:2.1.x May 16, 2026
658 of 660 checks passed

staabm deleted the create-pull-request/patch-z2pzrmn branch May 16, 2026 12:17

phpstan-bot mentioned this pull request May 16, 2026

define('X', ..) should validate types against dynamicConstantNames phpstan/phpstan#14600

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate `define()` and `const` values against explicit types in `dynamicConstantNames`#5648

Validate `define()` and `const` values against explicit types in `dynamicConstantNames`#5648
staabm merged 12 commits into
phpstan:2.1.xfrom
phpstan-bot:create-pull-request/patch-z2pzrmn

phpstan-bot commented May 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VincentLanglet commented May 12, 2026

Uh oh!

staabm commented May 12, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VincentLanglet May 16, 2026

Uh oh!

phpstan-bot May 16, 2026

Uh oh!

VincentLanglet May 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	'Configuration defined type for constant %s::%s (%s) is incompatible with value %s.',
	'Configuration defined type for constant %s::%s (%s) does not accept value %s.',

Conversation

phpstan-bot commented May 12, 2026

Summary

Changes

Analogous cases probed

Root cause

Test

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VincentLanglet commented May 12, 2026

Uh oh!

staabm commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

VincentLanglet May 16, 2026

Choose a reason for hiding this comment

Uh oh!

phpstan-bot May 16, 2026

Choose a reason for hiding this comment

Uh oh!

VincentLanglet May 16, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

staabm commented May 12, 2026 •

edited

Loading